Generate docs sidebar sections automatically #480
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
avatus
previously approved these changes
Jul 1, 2024
| import { existsSync, readFileSync } from "fs"; | ||
| import { dirname, resolve, join } from "path"; | ||
| import fs from "fs"; |
There was a problem hiding this comment.
this is fine, but wondering why the change?
There was a problem hiding this comment.
generateNavPaths takes fs as an argument so I can use the in-memory fs from the memfs package in tests!
There was a problem hiding this comment.
Oh I see now. That's awesome
Comment on lines
+332
to
+334
| if (!!item.generateFrom && item.entries.length > 0) { | ||
| throw "a navigation item cannot contain both generateFrom and entries"; | ||
| } |
There was a problem hiding this comment.
thank you for the check here!
Comment on lines
+78
to
+79
| let firstLvlFiles = new Set(); | ||
| let firstLvlDirs = new Set(); |
Add a `config.json` field within each `navigation` entry called `generateFrom`. This designates a relative path from `docs/pages` from which to generate entries within the sidebar. When generating pages, a function called `generateNavPaths` looks for pages to use as second-level section introductions. As with the Docusaurus convention, second-level section introductions have the same name as their parent directory. Adding a `generateFrom` field is consistent with the Docusaurus approach to sidebar generation, in which a configuration field indicates which directory to generate a section from. This gives us control over the title and icons we use for navigation sections, which aren't available to fetch from a directory tree alone. It also lets us use the current, hardcoded `entries` approach for some sections if we need to. Also un-skips some accidentally skipped tests.
ptgott
force-pushed
the
paul.gottschling/2024-07-01-gen-nav
branch
from
50a8de8
to
c6d9cdd
Compare
|
@avatus I've reworked this a little bit to change the expectations for subdirectory pages. I've added the expectation from Docusaurus that a category page have the same title as the parent directory (docs). Docusaurus also allows category pages to be called |
avatus
approved these changes
Jul 2, 2024
travelton
pushed a commit
that referenced
this pull request
Aug 26, 2024
Add a `config.json` field within each `navigation` entry called `generateFrom`. This designates a relative path from `docs/pages` from which to generate entries within the sidebar. When generating pages, a function called `generateNavPaths` looks for pages to use as second-level section introductions. As with the Docusaurus convention, second-level section introductions have the same name as their parent directory. Adding a `generateFrom` field is consistent with the Docusaurus approach to sidebar generation, in which a configuration field indicates which directory to generate a section from. This gives us control over the title and icons we use for navigation sections, which aren't available to fetch from a directory tree alone. It also lets us use the current, hardcoded `entries` approach for some sections if we need to. Also un-skips some accidentally skipped tests.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a
config.jsonfield within eachnavigationentry calledgenerateFrom. This designates a relative path fromdocs/pagesfrom which to generate entries within the sidebar.When generating pages, a function called
generateNavPathslooks for pages to use as second-level section introductions. These can either be calledintroduction.mdxor have the same name as a second-level subdirectory.Adding a
generateFromfield is consistent with the Docusaurus approach to sidebar generation, in which a configuration field indicates which directory to generate a section from. This gives us control over the title and icons we use for navigation sections, which aren't available to fetch from a directory tree alone. It also lets us use the current, hardcodedentriesapproach for some sections if we need to.Also un-skips some accidentally skipped tests.